Skip to content

Conversation

@kosabogi
Copy link
Contributor

This PR fixes description errors discovered during the https://github.com/elastic/docs-content-internal/issues/280 of the 8.x and 9.x API documentation.

Closes #5508, #5509, #5510, #5511, #5512

@github-actions
Copy link
Contributor

github-actions bot commented Oct 29, 2025

Following you can find the validation changes against the target branch for the APIs.

No changes detected.

You can validate these APIs yourself by using the make validate target.

leemthompo
leemthompo previously approved these changes Oct 29, 2025
@leemthompo leemthompo dismissed their stale review October 29, 2025 16:41

Sorry was on auto-pilot and I thought this was a backport 🙈

I noticed a small nit that might confuse users

completion,
rerank,
space_embedding,
sparse_embedding,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😁

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧑‍🚀

Copy link
Member

@davidkyle davidkyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kosabogi kosabogi merged commit 518ccd9 into main Nov 4, 2025
8 checks passed
@kosabogi kosabogi deleted the inference-fixes branch November 4, 2025 14:42
@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

The backport to 9.1 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.1 9.1
# Navigate to the new working tree
cd .worktrees/backport-9.1
# Create a new branch
git switch --create backport-5566-to-9.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 518ccd9a1ab34d9410c9e988fc23a3b921252f71
# Push it to GitHub
git push --set-upstream origin backport-5566-to-9.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.1

Then, create a pull request where the base branch is 9.1 and the compare/head branch is backport-5566-to-9.1.

github-actions bot pushed a commit that referenced this pull request Nov 4, 2025
* Improves descriptions in the Inference APIs

* Update specification/inference/delete/DeleteRequest.ts

Co-authored-by: Liam Thompson <[email protected]>

* Update specification/inference/put/PutRequest.ts

Co-authored-by: David Kyle <[email protected]>

* Fixes chunking_settings object descriptions

* Fixes oxford comma

* Formatting fix

---------

Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: David Kyle <[email protected]>
(cherry picked from commit 518ccd9)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing prerequisites in the Inference API documentation

4 participants